|
battmon5 2.2.1
|
API for configuring and manipulating BATT-MON 5 Click driver. More...
Topics | |
| BATT-MON 5 Registers List | |
| List of registers of BATT-MON 5 Click driver. | |
| BATT-MON 5 Registers Settings | |
| Settings for registers of BATT-MON 5 Click driver. | |
| BATT-MON 5 MikroBUS Map | |
| MikroBUS pin mapping of BATT-MON 5 Click driver. | |
Functions | |
| void | battmon5_cfg_setup (battmon5_cfg_t *cfg) |
| BATT-MON 5 configuration object setup function. | |
| err_t | battmon5_init (battmon5_t *ctx, battmon5_cfg_t *cfg) |
| BATT-MON 5 initialization function. | |
| err_t | battmon5_default_cfg (battmon5_t *ctx) |
| BATT-MON 5 default configuration function. | |
| err_t | battmon5_write_reg (battmon5_t *ctx, uint8_t reg, uint16_t data_in) |
| BATT-MON 5 write reg function. | |
| err_t | battmon5_read_reg (battmon5_t *ctx, uint8_t reg, uint16_t *data_out) |
| BATT-MON 5 read reg function. | |
| uint8_t | battmon5_get_alarm_pin (battmon5_t *ctx) |
| BATT-MON 5 get alarm pin function. | |
API for configuring and manipulating BATT-MON 5 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void battmon5_cfg_setup | ( | battmon5_cfg_t * | cfg | ) |
BATT-MON 5 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See battmon5_cfg_t object definition for detailed explanation. |
| err_t battmon5_default_cfg | ( | battmon5_t * | ctx | ) |
BATT-MON 5 default configuration function.
This function executes a default configuration of BATT-MON 5 Click board.
| [in] | ctx | : Click context object. See battmon5_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | uint8_t battmon5_get_alarm_pin | ( | battmon5_t * | ctx | ) |
BATT-MON 5 get alarm pin function.
This function returns the ALARM pin logic state.
| [in] | ctx | : Click context object. See battmon5_t object definition for detailed explanation. |
| err_t battmon5_init | ( | battmon5_t * | ctx, |
| battmon5_cfg_t * | cfg ) |
BATT-MON 5 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See battmon5_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See battmon5_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t battmon5_read_reg | ( | battmon5_t * | ctx, |
| uint8_t | reg, | ||
| uint16_t * | data_out ) |
BATT-MON 5 read reg function.
This function reads a data word from the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See battmon5_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [out] | data_out | : Output read data word. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t battmon5_write_reg | ( | battmon5_t * | ctx, |
| uint8_t | reg, | ||
| uint16_t | data_in ) |
BATT-MON 5 write reg function.
This function writes a data word starting to the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See battmon5_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [in] | data_in | : Data word to be written. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation.